home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / fish / 676-700 / 682 / reqchange / extra / getfile.man < prev    next >
Text File  |  1995-03-18  |  4KB  |  122 lines
  1.  
  2.  
  3.         GetFile V1.1             User manual              GetFile V1.1
  4.  
  5.  
  6.         NAME 
  7.             GetFile 
  8.  
  9.         SYNOPSIS 
  10.              GetFile [[FILE] File] [[TITLE] Titlestring] [[VAR]
  11.                     Variablename] [[PATTERN] Pattern] [GLOBAL]
  12.                     [NOFILES] [SAVE] [MULTISELECT] 
  13.  
  14.         DESCRIPTION 
  15.             NOTE: This program only works with OS 2.04! 
  16.  
  17.             GetFile  is  a  little  command  intended  to  be  used in
  18.             scripts  (Shell or ARexx), where an input from the user in
  19.             the  form  of  a  filename  or a directory name is needed.
  20.             The  requester  used  is  the  OS2.0 standard requester in
  21.             ASL.   If  no  file  was  selected,  the WARN flag will be
  22.             set.  
  23.  
  24.         OPTIONS 
  25.             There  are no required arguments. The keywords (see below)
  26.             are  only  required if you do not enter the strings in the
  27.             ordering  as above. Strings only need to be quoted if they
  28.             contain spaces.  
  29.  
  30.             FILE 
  31.                 This  lets  you  specify  the default directory and/or
  32.                 filename.  If none is specified, the current directory
  33.                 will be the default directory.  
  34.  
  35.             TITLE 
  36.                 This  optional  string  specifies  the  title  in  the
  37.                 requester  window.  It  defaults to "Select a file" if
  38.                 none is specified.  
  39.  
  40.             VAR 
  41.                 This  string  lets you specify in which local variable
  42.                 the   result   will   be   stored   (with   full  path
  43.                 specification). The default name is GetFileResult.  
  44.  
  45.             PATTERN 
  46.                 This  string  specifies  the  pattern to use. Only the
  47.                 filenames  that  matches the pattern will be shown. It
  48.                 also implies for a pattern gadget.  
  49.  
  50.             GLOBAL 
  51.                 By  default,  GetFile will place the answer in a local
  52.                 environment  variable.  But this has one drawback: You
  53.                 can't  access  the  result  easily  from ARexx. If you
  54.                 have  set  this  flag,  it  will be quite easy. Simply
  55.                 peek in the ENV: directory. :) 
  56.  
  57.             NOFILES 
  58.  
  59.  
  60.                                     Page 1
  61.  
  62.  
  63.         GetFile V1.1             User manual              GetFile V1.1
  64.  
  65.  
  66.                 If  this keyword is present, then the user will not be
  67.                 able  to  select  any  files, only directories will be
  68.                 shown.   Very   nice  if  the  user  should  select  a
  69.                 destination     directory     for     e.g.    harddisk
  70.                 installation.  
  71.  
  72.             SAVE 
  73.                 If   this  keyword  is  present,  the  requester  will
  74.                 operate  in save mode, which is a bit different. First
  75.                 of  all,  double-clicking  a  file will have no effect
  76.                 (except  from  selecting  that file ofcourse!), and if
  77.                 the  user  enters  a  directory  which  doesn't exist,
  78.                 there  will  be a requester asking if the directory in
  79.                 question  should be created. The look of the requester
  80.                 will be somewhat different.  
  81.  
  82.             MULTISELECT 
  83.                 If  this  keyword is present, the user will be able to
  84.                 select  multiple  files (if the SAVE switch is used at
  85.                 the   same  time,  this  keyword  does  nothing).  The
  86.                 returned  string  will  be  space-separated  filenames
  87.                 with  full  path specification. If a filename contains
  88.                 spaces,  it  will  be  quoted.  This keyword is mostly
  89.                 intended  to  be  used from ARexx-scripts (since it is
  90.                 quite easy to process the result in ARexx).  
  91.  
  92.         EXAMPLE 
  93.             GetFile TITLE "Select destination directory" NOFILES 
  94.             Echo "Files will be placed in $GetFileResult"
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.                                     Page 2
  121.  
  122.